/*
 * Copyright (C) 2020 The LINN Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.juqimiao.linn.transfer.query;

/**
 * 表示一个模糊搜索匹配条件。
 * 通常代表一个独立在SQL语句或ES检索中的一个独立搜索条件。其中matchingPattern需要用户自行约定。
 * <p>
 * 它可能代表SQL中 WHERE 语句中的
 * 1. columnName = '%value' [%value%] [_value_] ...
 * 它也可能代表在ES检索中的：
 * {
 *     "query": {
 *         "regexp":{
 *             "name.first":{
 *                 "value":"s.*y",
 *                 "boost":1.2
 *             }
 *         }
 *     }
 * }
 * 或
 * {
 *     "query": {
 *         "wildcard" : { "user" : { "value" : "ki*y", "boost" : 2.0 } }
 *     }
 * }
 * </p>
 *
 * @author      Collin Cai
 */
public class FuzzyCriteria<T, M> extends ColumnCriteria<T> {

    /* ---- Static Field ----------- */

    private static final long serialVersionUID = 5233782938470098724L;

    /* ---- Field ----------- */

    private M matchingPattern;

    /* ---- Properties ----------- */

    /**
     * 获取排序方式。
     *
     * @return 表示排序方式的对象。
     */
    public M getMatchingPattern() {
        return (M) matchingPattern;
    }

    /**
     * 设置排序方式。
     *
     * @param matchingPattern 表示排序方式的对象。
     */
    public void setMatchingPattern(M matchingPattern) {
        this.matchingPattern = matchingPattern;
    }

    /* ---- Constructor ----------- */

    /**
     * 构造器。
     *
     * @param name            列名。
     * @param value           列的值。
     * @param matchingPattern 表示匹配的对象。
     */
    public FuzzyCriteria(String name, T value, M matchingPattern) {
        super(name, value);
        this.matchingPattern = matchingPattern;
    }
}

